
<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>API for Placer &#8212; PCB-Layout-Framework  documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script src="_static/jquery.js"></script>
    <script src="_static/underscore.js"></script>
    <script src="_static/doctools.js"></script>
    <script src="_static/language_data.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="API for Router" href="router.html" />
    <link rel="prev" title="API for Database" href="database.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="api-for-placer">
<h1>API for Placer<a class="headerlink" href="#api-for-placer" title="Permalink to this headline">¶</a></h1>
<dl class="cpp class">
<dt>
<code class="sig-name descname">GridBasedPlacer()</code></dt>
<dd><p>This is the placer class. You will need to instantiate an instance of this class to run a placement job.</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer17test_hplacer_flowEv">
<span id="_CPPv3N15GridBasedPlacer17test_hplacer_flowEv"></span><span id="_CPPv2N15GridBasedPlacer17test_hplacer_flowEv"></span><span id="GridBasedPlacer::test_hplacer_flow"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">test_hplacer_flow</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer17test_hplacer_flowEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>This is the main function that runs placement.</p>
</dd></dl>

<div class="section" id="getters">
<h2>Getters<a class="headerlink" href="#getters" title="Permalink to this headline">¶</a></h2>
<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer14get_total_costEv">
<span id="_CPPv3N15GridBasedPlacer14get_total_costEv"></span><span id="_CPPv2N15GridBasedPlacer14get_total_costEv"></span><span id="GridBasedPlacer::get_total_cost"></span>double <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">get_total_cost</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer14get_total_costEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Gets the total weighted cost (badness) of the current solution.</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer19get_wirelength_costEv">
<span id="_CPPv3N15GridBasedPlacer19get_wirelength_costEv"></span><span id="_CPPv2N15GridBasedPlacer19get_wirelength_costEv"></span><span id="GridBasedPlacer::get_wirelength_cost"></span>double <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">get_wirelength_cost</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer19get_wirelength_costEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Gets the total weighted cost of the wire length.</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer16get_overlap_costEv">
<span id="_CPPv3N15GridBasedPlacer16get_overlap_costEv"></span><span id="_CPPv2N15GridBasedPlacer16get_overlap_costEv"></span><span id="GridBasedPlacer::get_overlap_cost"></span>double <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">get_overlap_cost</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer16get_overlap_costEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Gets the total weighted cost of overlap.</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer15get_temperatureEv">
<span id="_CPPv3N15GridBasedPlacer15get_temperatureEv"></span><span id="_CPPv2N15GridBasedPlacer15get_temperatureEv"></span><span id="GridBasedPlacer::get_temperature"></span>double <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">get_temperature</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer15get_temperatureEv" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Gets the current temperature.</p>
</dd></dl>

</div>
<div class="section" id="setters">
<h2>Setters<a class="headerlink" href="#setters" title="Permalink to this headline">¶</a></h2>
<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer12set_base_lamEd">
<span id="_CPPv3N15GridBasedPlacer12set_base_lamEd"></span><span id="_CPPv2N15GridBasedPlacer12set_base_lamEd"></span><span id="GridBasedPlacer::set_base_lam__double"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_base_lam</code><span class="sig-paren">(</span>double <em>_lam</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer12set_base_lamEd" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer9set_bb_ecEb">
<span id="_CPPv3N15GridBasedPlacer9set_bb_ecEb"></span><span id="_CPPv2N15GridBasedPlacer9set_bb_ecEb"></span><span id="GridBasedPlacer::set_bb_ec__b"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_bb_ec</code><span class="sig-paren">(</span>bool <em>_bb</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer9set_bb_ecEb" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer21set_wirelength_weightEd">
<span id="_CPPv3N15GridBasedPlacer21set_wirelength_weightEd"></span><span id="_CPPv2N15GridBasedPlacer21set_wirelength_weightEd"></span><span id="GridBasedPlacer::set_wirelength_weight__double"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_wirelength_weight</code><span class="sig-paren">(</span>double <em>_cst</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer21set_wirelength_weightEd" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer19set_lambda_scheduleEd">
<span id="_CPPv3N15GridBasedPlacer19set_lambda_scheduleEd"></span><span id="_CPPv2N15GridBasedPlacer19set_lambda_scheduleEd"></span><span id="GridBasedPlacer::set_lambda_schedule__double"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_lambda_schedule</code><span class="sig-paren">(</span>double <em>_lsched</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer19set_lambda_scheduleEd" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer13set_two_sidedEb">
<span id="_CPPv3N15GridBasedPlacer13set_two_sidedEb"></span><span id="_CPPv2N15GridBasedPlacer13set_two_sidedEb"></span><span id="GridBasedPlacer::set_two_sided__b"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_two_sided</code><span class="sig-paren">(</span>bool <em>_2sided</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer13set_two_sidedEb" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer23set_initial_move_radiusEd">
<span id="_CPPv3N15GridBasedPlacer23set_initial_move_radiusEd"></span><span id="_CPPv2N15GridBasedPlacer23set_initial_move_radiusEd"></span><span id="GridBasedPlacer::set_initial_move_radius__double"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_initial_move_radius</code><span class="sig-paren">(</span>double <em>_eps</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer23set_initial_move_radiusEd" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Sets the starting move radius. The move radius decreases automatically during placement.</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer9set_rtreeEb">
<span id="_CPPv3N15GridBasedPlacer9set_rtreeEb"></span><span id="_CPPv2N15GridBasedPlacer9set_rtreeEb"></span><span id="GridBasedPlacer::set_rtree__b"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_rtree</code><span class="sig-paren">(</span>bool <em>_rt</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer9set_rtreeEb" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Sets the usage of rtree data structure for detecting overlap. This can provide faster performance on large designs.</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer7set_lamEb">
<span id="_CPPv3N15GridBasedPlacer7set_lamEb"></span><span id="_CPPv2N15GridBasedPlacer7set_lamEb"></span><span id="GridBasedPlacer::set_lam__b"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_lam</code><span class="sig-paren">(</span>bool <em>_lam</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer7set_lamEb" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer18set_lamtemp_updateEd">
<span id="_CPPv3N15GridBasedPlacer18set_lamtemp_updateEd"></span><span id="_CPPv2N15GridBasedPlacer18set_lamtemp_updateEd"></span><span id="GridBasedPlacer::set_lamtemp_update__double"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_lamtemp_update</code><span class="sig-paren">(</span>double <em>_coef</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer18set_lamtemp_updateEd" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer18set_num_iterationsEi">
<span id="_CPPv3N15GridBasedPlacer18set_num_iterationsEi"></span><span id="_CPPv2N15GridBasedPlacer18set_num_iterationsEi"></span><span id="GridBasedPlacer::set_num_iterations__i"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_num_iterations</code><span class="sig-paren">(</span>int <em>iter</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer18set_num_iterationsEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Sets the number of annealing iterations (temperature updates).</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer20set_iterations_movesEi">
<span id="_CPPv3N15GridBasedPlacer20set_iterations_movesEi"></span><span id="_CPPv2N15GridBasedPlacer20set_iterations_movesEi"></span><span id="GridBasedPlacer::set_iterations_moves__i"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_iterations_moves</code><span class="sig-paren">(</span>int <em>iter</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer20set_iterations_movesEi" title="Permalink to this definition">¶</a><br /></dt>
<dd><p>Sets the number of moves per component during annealing. The total moves per temperature update will be this number times the number of components.</p>
</dd></dl>

<dl class="cpp function">
<dt id="_CPPv4N15GridBasedPlacer23set_initial_temperatureEd">
<span id="_CPPv3N15GridBasedPlacer23set_initial_temperatureEd"></span><span id="_CPPv2N15GridBasedPlacer23set_initial_temperatureEd"></span><span id="GridBasedPlacer::set_initial_temperature__double"></span>void <code class="sig-prename descclassname">GridBasedPlacer<code class="sig-prename descclassname">::</code></code><code class="sig-name descname">set_initial_temperature</code><span class="sig-paren">(</span>double <em>tmp</em><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N15GridBasedPlacer23set_initial_temperatureEd" title="Permalink to this definition">¶</a><br /></dt>
<dd></dd></dl>

</div>
</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">PCB-Layout-Framework</a></h1>








<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="database.html">API for Database</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">API for Placer</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#getters">Getters</a></li>
<li class="toctree-l2"><a class="reference internal" href="#setters">Setters</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="router.html">API for Router</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="index.html">Documentation overview</a><ul>
      <li>Previous: <a href="database.html" title="previous chapter">API for Database</a></li>
      <li>Next: <a href="router.html" title="next chapter">API for Router</a></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, [blinded for review].
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.1.0</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="_sources/placer.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>